home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr26 / gzip111.zip / GZIP.DOC < prev    next >
Text File  |  1993-06-01  |  11KB  |  245 lines
  1.  
  2. GZIP(1)                  USER COMMANDS                    GZIP(1)
  3.  
  4. NAME
  5.      gzip, gunzip, zcat - compress or expand files
  6.  
  7. SYNOPSIS
  8.      gzip [ -acdfhLrtvV19 ] [-S suffix] [ name ... ]
  9.      gunzip [ -acfhLrtvV ] [-S suffix] [ name ... ]
  10.      zcat [ -hLV ] [ name ... ]
  11.  
  12. DESCRIPTION
  13.      Gzip reduces the size of the named  files  using  Lempel-Ziv
  14.      coding  (LZ77).  Whenever possible, each file is replaced by
  15.      one with the extension .gz, while keeping the same ownership
  16.      modes,  access  and modification times.  (The default exten-
  17.      sion is -gz for VMS, z for MSDOS, OS/2  and  Atari.)  If  no
  18.      files are specified, the standard input is compressed to the
  19.      standard output. If the new file  name  is  too  long,  gzip
  20.      truncates  it  and  keeps  the  original  file  name  in the
  21.      compressed file.  Gzip will only attempt to compress regular
  22.      files.  In particular, it will ignore symbolic links.
  23.  
  24.      Compressed files can be  restored  to  their  original  form
  25.      using gzip -d or gunzip or zcat.
  26.  
  27.      gunzip takes a  list  of  files  on  its  command  line  and
  28.      replaces each file whose name ends with .gz, -gz, .z, -z, _z
  29.      or .Z and which begins with the correct magic number with an
  30.      uncompressed  file  without  the original extension.  gunzip
  31.      also recognizes the special  extensions  .tgz  and  .taz  as
  32.      shorthands for .tar.gz and .tar.Z respectively.
  33.  
  34.      gunzip can currently decompress files created by gzip,  zip,
  35.      compress  or  pack.  The  detection  of  the input format is
  36.      automatic.  When using the first two formats, gunzip  checks
  37.      a  32  bit  CRC.  For  pack,  gunzip checks the uncompressed
  38.      length. The compress format was not designed to  allow  con-
  39.      sistency  checks. However gunzip is sometimes able to detect
  40.      a bad .Z file. If you get an error when uncompressing  a  .Z
  41.      file,  do  not  assume  that  the  .Z file is correct simply
  42.      because the standard uncompress does not complain. This gen-
  43.      erally means that the standard uncompress does not check its
  44.      input, and happily generates garbage output.
  45.  
  46.      Files created by zip can be uncompressed  by  gzip  only  if
  47.      they  have  a  single member compressed with the 'deflation'
  48.      method. This feature is only intended to help conversion  of
  49.      tar.zip  files  to  the  tar.gz format. To extract zip files
  50.      with several members, use unzip instead of gunzip.
  51.  
  52.      zcat is identical to gunzip -c. (On some systems,  zcat  may
  53.      be  installed  as  gzcat  to  preserve  the original link to
  54.      compress.) zcat uncompresses either a list of files  on  the
  55.      command   line   or   its  standard  input  and  writes  the
  56.      uncompressed data on standard output.  zcat will  uncompress
  57.      files that have the correct magic number whether they have a
  58.      .gz suffix or not.
  59.  
  60.      Gzip uses the Lempel-Ziv algorithm used in  zip  and  PKZIP.
  61.      The  amount  of  compression obtained depends on the size of
  62.      the input and the distribution of common substrings.   Typi-
  63.      cally,  text  such  as  source code or English is reduced by
  64.      60-70%.  Compression is  generally  much  better  than  that
  65.      achieved  by  LZW  (as used in compress), Huffman coding (as
  66.      used in pack), or adaptive Huffman coding (compact).
  67.  
  68.      Compression is always performed, even if the compressed file
  69.      is  slightly larger than the original. The worst case expan-
  70.      sion is a few bytes for the gzip file header, plus  5  bytes
  71.      every  32K  block, or an expansion ratio of 0.015% for large
  72.      files. Note that the  actual  number  of  used  disk  blocks
  73.      almost  never increases.  gzip preserves the mode, ownership
  74.      and timestamps of files when compressing or decompressing.
  75.  
  76. OPTIONS
  77.      -a --ascii
  78.           Ascii text mode: convert end-of-lines using local  con-
  79.           ventions.  This  option  is supported only on some non-
  80.           Unix systems. For MSDOS, CR LF is converted to LF  when
  81.           compressing,   and  LF  is  converted  to  CR  LF  when
  82.           decompressing.
  83.  
  84.      -c --stdout
  85.           Write output on standard output;  keep  original  files
  86.           unchanged.   If there are several input files, the out-
  87.           put consists of a sequence of independently  compressed
  88.           members.  To obtain better compression, concatenate all
  89.           input files before compressing them.
  90.  
  91.      -d --decompress --uncompress
  92.           Decompress.
  93.  
  94.      -f --force
  95.           Force compression or decompression even if the file has
  96.           multiple   links  or  the  corresponding  file  already
  97.           exists, or if the compressed data is read from or writ-
  98.           ten  to  a  terminal.  If -f is not given, and when not
  99.           running in  the  background,  gzip  prompts  to  verify
  100.           whether an existing file should be overwritten.
  101.  
  102.      -h --help
  103.           Display a help screen and quit.
  104.  
  105.      -L --license
  106.           Display the gzip license.
  107.  
  108.      -q --quiet
  109.           Suppress all warnings.
  110.  
  111.      -r --recurse
  112.           Travel the directory structure recursively. If  any  of
  113.           the file names specified on the command line are direc-
  114.           tories,  gzip  will  descend  into  the  directory  and
  115.           compress  all  the  files it finds there (or decompress
  116.           them in the case of gunzip ).
  117.  
  118.      -S .z --suffix .z
  119.           Use suffix .z instead of .gz. Any suffix can be  given,
  120.           but suffixes other than .z and .gz should be avoided to
  121.           avoid confusion when files  are  transferred  to  other
  122.           systems.  Previous versions of gzip used the .z suffix.
  123.           This was changed to avoid a conflict with pack(1).
  124.  
  125.      -t --test
  126.           Test. Check the compressed file integrity.
  127.  
  128.      -v --verbose
  129.           Verbose. Display the name and percentage reduction  for
  130.           each file compressed.
  131.  
  132.      -V --version
  133.           Version. Display the  version  number  and  compilation
  134.           options then quit.
  135.  
  136.      -# --fast --best
  137.           Regulate the speed of compression using  the  specified
  138.           digit  #,  where  -1  or  --fast  indicates the fastest
  139.           compression method (less compression) and -9 or  --best
  140.           indicates   the  slowest  compression  method  (optimal
  141.           compression).  The default compression level is -5.
  142.  
  143. ADVANCED USAGE
  144.      Multiple compressed files can be concatenated. In this case,
  145.      gunzip will extract all members at once. For example:
  146.  
  147.            gzip -c file1  > foo.gz
  148.            gzip -c file2 >> foo.gz
  149.  
  150.      Then
  151.            gunzip -c foo
  152.  
  153.      is equivalent to
  154.  
  155.            cat file1 file2
  156.  
  157.      In case of damage to one member of a .gz file, other members
  158.      can  still  be recovered (if the damaged member is removed).
  159.      However, you can get better compression by  compressing  all
  160.      members at once:
  161.  
  162.            cat file1 file2 | gzip > foo.gz
  163.  
  164.      compresses better than
  165.  
  166.            gzip -c file1 file2 > foo.gz
  167.  
  168.      If you want to recompress concatenated files to  get  better
  169.      compression, do:
  170.  
  171.            zcat old.gz | gzip > new.gz
  172.  
  173. ENVIRONMENT
  174.      The environment variable GZIP can  hold  a  set  of  default
  175.      options  for  gzip.  These options are interpreted first and
  176.      can be overwritten by explicit command line parameters.  For
  177.      example:
  178.            for sh:    GZIP="-8 -v"; export GZIP
  179.            for csh:   setenv GZIP "-8 -v"
  180.            for MSDOS: set GZIP=-8 -v
  181.  
  182.      On  Vax/VMS,  the  name  of  the  environment  variable   is
  183.      GZIP_OPT,  to avoid a conflict with the symbol set for invo-
  184.      cation of the program.
  185.  
  186. SEE ALSO
  187.      znew(1), zcmp(1),  zmore(1),  zforce(1),  gzexe(1),  zip(1),
  188.      unzip(1), compress(1), pack(1), compact(1)
  189.  
  190. DIAGNOSTICS
  191.      Exit status is normally 0; if an error occurs,  exit  status
  192.      is 1. If a warning occurs, exit status is 2.
  193.  
  194.      Usage: gzip [-cdfhLrtvV19] [-S suffix] [file ...]
  195.              Invalid options were specified on the command line.
  196.      file: not in gzip format
  197.              The  file  specified  to   gunzip   has   not   been
  198.              compressed.
  199.      file: Corrupt input. Use zcat to recover some data.
  200.              The compressed file has been damaged. The data up to
  201.              the point of failure can be recovered using
  202.                      zcat file > recover
  203.      file: compressed with xx bits, can only handle yy bits
  204.              File was compressed (using LZW) by  a  program  that
  205.              could  deal  with more bits than the decompress code
  206.              on this machine.  Recompress  the  file  with  gzip,
  207.              which compresses better and uses less memory.
  208.      file: already has .gz suffix -- no change
  209.              The  file  is  assumed  to  be  already  compressed.
  210.              Rename the file and try again.
  211.      file already exists; do you wish to overwrite (y or n)?
  212.              Respond "y" if  you  want  the  output  file  to  be
  213.              replaced; "n" if not.
  214.      gunzip: corrupt input
  215.              A SIGSEGV violation was detected which usually means
  216.              that the input file has been corrupted.
  217.      xx.x%
  218.              Percentage  of  the  input  saved  by   compression.
  219.              (Relevant only for -v.)
  220.      -- not a regular file or directory: ignored
  221.              When the input file is not a regular file or  direc-
  222.              tory,  (e.g.  a  symbolic link, socket, FIFO, device
  223.              file), it is left unaltered.
  224.      -- has xx other links: unchanged
  225.              The input file has links; it is left unchanged.  See
  226.              ln(1) for more information. Use the -f flag to force
  227.              compression of multiply-linked files.
  228.  
  229. CAVEATS
  230.      When writing compressed data to  a  tape,  it  is  generally
  231.      necessary  to pad the output with zeroes up to a block boun-
  232.      dary. When the data is read and the whole block is passed to
  233.      gunzip for decompression, gunzip detects that there is extra
  234.      trailing garbage after the compressed data and emits a warn-
  235.      ing  by  default.  You  have  to  use  the --quiet option to
  236.      suppress the warning. This option can be  set  in  the  GZIP
  237.      environment variable as in:
  238.          for sh:    GZIP="-q"  tar xfz /dev/rmt/datn
  239.          for csh:   (setenv GZIP "-q"; tar xfz /dev/rmt/datn)
  240.  
  241.      In the above example, gzip is invoked implicitly by  the  -z
  242.      option  of  GNU  tar. Make sure that the same block size (-b
  243.      option of tar) is used for reading  and  writing  compressed
  244.      data on tapes.
  245.